reticle_on_different_bckgnd_colors.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
"""
...\PTVR_Researchers\Python_Scripts\Demos\Pointing\
    reticle_on_different_bckgnd_colors.py
    
This demo is the same as the reticle.py script except that:
    - the 'two_colors' parameter is set to "True" in ReticleImageFromDrawing()
    In this case, the reticle is made of two contours (white and black),
    which makes it ideal for a background containing dark and bright patches
    of colors.
    
    - there are five Flat Screens with different luminances (from black to
                                                             white)
    so that you can move the reticle above dark or bright surfaces and check
    that the reticle is clearly visible in all cases.
 
Created by Carlos Aguilar in March 2025
 
"""
 
from PTVR.Visual import The3DWorld
from PTVR.Stimuli.Objects import FlatScreen
from PTVR.Stimuli.Scenes import VisualScene
from PTVR.Pointing.PointingCursor import *
import PTVR.Pointing.ReticleImageFromDrawing as RG
from PTVR.SystemUtils import LaunchThe3DWorld
import numpy as np
import PTVR.Stimuli.Color as color
 
my_contingency = ImageContingency.HEADSET
 
my_world = The3DWorld()
 
grey_level_1 = 1.0
grey_level_2 = 0.75
grey_level_3 = 0.5
grey_level_4 = 0.25
grey_level_5 = 0.0
 
 
def main():
 
    my_scene = VisualScene()
 
    reticle_2D_image = RG.ReticleImageFromDrawing(
        two_colors = True  # creates a BICOLOR reticle
        # note : with a bicolor reticle, the 'reticle_line_width_as_ratio'
        # parameter refers to the white circle's width.
    )
 
    # If you want to open a window on your PC showing the reticle image
    # that has just been internally drawn, comment out the following line.
    # reticle_2D_image.Show()
 
    # transform 'reticle_2D_image' into a contingent cursor.
    my_reticle = ImageToContingentCursor(
        image=reticle_2D_image,
        contingency_type=my_contingency)
    my_scene.place_contingent_cursor(my_reticle)
 
    flat_screen_1 = FlatScreen(position_in_current_CS=np.array([-2, 0, 3]),
                               color=color.RGBColor(r=grey_level_1, g=grey_level_1,
                                                    b=grey_level_1, a=1.0))
    flat_screen_2 = FlatScreen(position_in_current_CS=np.array([-1, 0, 3]),
                               color=color.RGBColor(r=grey_level_2, g=grey_level_2,
                                                    b=grey_level_2, a=1.0))
    flat_screen_3 = FlatScreen(position_in_current_CS=np.array([0, 0, 3]),
                               color=color.RGBColor(r=grey_level_3, g=grey_level_3,
                                                    b=grey_level_3, a=1.0))
    flat_screen_4 = FlatScreen(position_in_current_CS=np.array([1, 0, 3]),
                               color=color.RGBColor(r=grey_level_4, g=grey_level_4,
                                                    b=grey_level_4, a=1.0))
    flat_screen_5 = FlatScreen(position_in_current_CS=np.array([2, 0, 3]),
                               color=color.RGBColor(r=grey_level_5, g=grey_level_5,
                                                    b=grey_level_5, a=1.0))
    my_scene.place(flat_screen_1, my_world)
    my_scene.place(flat_screen_2, my_world)
    my_scene.place(flat_screen_3, my_world)
    my_scene.place(flat_screen_4, my_world)
    my_scene.place(flat_screen_5, my_world)
 
    my_world.add_scene(my_scene)
    my_world.write()
 
 
if __name__ == "__main__":
    main()
    LaunchThe3DWorld()  # Launch the Experiment with PTVR.